near-api-js
![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)
A JavaScript/TypeScript library for development of DApps on the NEAR platform
Documentation
Read the TypeDoc API documentation
Contribute to this library
-
Install dependencies
yarn
-
Run continuous build with:
yarn build -- -w
Publish
Prepare dist
version by running:
yarn dist
When publishing to npm use np.
Integration Test
Start the node by following instructions from nearcore, then
yarn test
Tests use sample contract from near-hello
npm package, see https://github.com/nearprotocol/near-hello
Update error messages
Follow next steps:
- Change hash for the commit with errors in the nearcore
- Generate new types for errors:
node gen_error_types.js
yarn fix
fix any issues with linter.yarn build
to update lib/**.js
files
License
This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
See LICENSE and LICENSE-APACHE for details.